/*
 * Copyright 2011 Subhabrata Ghosh <subho.ghosh at langene.net>.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */



package net.langene.nlp.training;

/**
 *
 * @author Subhabrata Ghosh <subho.ghosh at langene.net>
 */
public interface Trainer {

    /**
     * Setup the training environment.
     * All initialization tasks must be performed here.
     *
     * @throws Exception
     */
    void setup() throws Exception;

    /**
     * Start the training.
     *
     * @param threads No of thread to run (if threading is required)
     * @throws Exception
     */
    void train(int threads) throws Exception;

    /**
     * Terminate the Trainer.
     */
    void terminate();

    /**
     * Check if the Trainer is running. 
     * @return
     */
    boolean isRunning();

    /**
     * Dispose the trainer.
     */
    void dispose();
}


//~ Formatted by Jindent --- http://www.jindent.com
